<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
        "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
	<head>
		<meta http-equiv="content-type" content="text/html; charset=utf-8" />
		<meta name="generator" content="JsDoc Toolkit" />
		
		<title>JsDoc Reference - GridController</title>

		<style type="text/css">
			/* default.css */
body
{
	font: 12px "Lucida Grande", Tahoma, Arial, Helvetica, sans-serif;
	width: 800px;
}

.header
{
	clear: both;
	background-color: #ccc;
	padding: 8px;
}

h1
{
	font-size: 150%;
	font-weight: bold;
	padding: 0;
	margin: 1em 0 0 .3em;
}

hr
{
	border: none 0;
	border-top: 1px solid #7F8FB1;
	height: 1px;
}

pre.code
{
	display: block;
	padding: 8px;
	border: 1px dashed #ccc;
}

#index
{
	margin-top: 24px;
	float: left;
	width: 160px;
	position: absolute;
	left: 8px;
	background-color: #F3F3F3;
	padding: 8px;
}

#content
{
	margin-left: 190px;
	width: 600px;
}

.classList
{
	list-style-type: none;
	padding: 0;
	margin: 0 0 0 8px;
	font-family: arial, sans-serif;
	font-size: 1em;
	overflow: auto;
}

.classList li
{
	padding: 0;
	margin: 0 0 8px 0;
}

.summaryTable { width: 100%; }

h1.classTitle
{
	font-size:170%;
	line-height:130%;
}

h2 { font-size: 110%; }
caption, div.sectionTitle
{
	background-color: #7F8FB1;
	color: #fff;
	font-size:130%;
	text-align: left;
	padding: 2px 6px 2px 6px;
	border: 1px #7F8FB1 solid;
}

div.sectionTitle { margin-bottom: 8px; }
.summaryTable thead { display: none; }

.summaryTable td
{
	vertical-align: top;
	padding: 4px;
	border-bottom: 1px #7F8FB1 solid;
	border-right: 1px #7F8FB1 solid;
}

/*col#summaryAttributes {}*/
.summaryTable td.attributes
{
	border-left: 1px #7F8FB1 solid;
	width: 140px;
	text-align: right;
}

td.attributes, .fixedFont
{
	line-height: 15px;
	color: #002EBE;
	font-family: "Courier New",Courier,monospace;
	font-size: 13px;
}

.summaryTable td.nameDescription
{
	text-align: left;
	font-size: 13px;
	line-height: 15px;
}

.summaryTable td.nameDescription, .description
{
	line-height: 15px;
	padding: 4px;
	padding-left: 4px;
}

.summaryTable { margin-bottom: 8px; }

ul.inheritsList
{
	list-style: square;
	margin-left: 20px;
	padding-left: 0;
}

.detailList {
	margin-left: 20px; 
	line-height: 15px;
}
.detailList dt { margin-left: 20px; }

.detailList .heading
{
	font-weight: bold;
	padding-bottom: 6px;
	margin-left: 0;
}

.light, td.attributes, .light a:link, .light a:visited
{
	color: #777;
	font-style: italic;
}

.fineprint
{
	text-align: right;
	font-size: 10px;
}
		</style>
	</head>

	<body>
<!-- ============================== header ================================= -->	
		<!-- begin static/header.html -->
		<div id="header">
</div>
		<!-- end static/header.html -->

<!-- ============================== classes index ============================ -->
		<div id="index">
			<!-- begin publish.classesIndex -->
			<div align="center"><a href="../index.html">Class Index</a>
| <a href="../files.html">File Index</a></div>
<hr />
<h2>Classes</h2>
<ul class="classList">
	
	<li><i><a href="../symbols/_global_.html">_global_</a></i></li>
	
	<li><a href="../symbols/AndroidKeyHandler.html">AndroidKeyHandler</a></li>
	
	<li><a href="../symbols/FocusableItem.html">FocusableItem</a></li>
	
	<li><a href="../symbols/FocusController.html">FocusController</a></li>
	
	<li><a href="../symbols/FullscreenPage.html">FullscreenPage</a></li>
	
	<li><a href="../symbols/GenericVideoPlayerController.html">GenericVideoPlayerController</a></li>
	
	<li><a href="../symbols/GridController.html">GridController</a></li>
	
	<li><a href="../symbols/GridFocusableItem.html">GridFocusableItem</a></li>
	
	<li><a href="../symbols/IndexPage.html">IndexPage</a></li>
	
	<li><a href="../symbols/NativeVideoPlayerController.html">NativeVideoPlayerController</a></li>
	
	<li><a href="../symbols/SideMenuFocusableItem.html">SideMenuFocusableItem</a></li>
	
	<li><a href="../symbols/SideNavController.html">SideNavController</a></li>
	
	<li><a href="../symbols/VideoCommandFocusableItem.html">VideoCommandFocusableItem</a></li>
	
	<li><a href="../symbols/VideoControlsController.html">VideoControlsController</a></li>
	
	<li><a href="../symbols/VideoDAO.html">VideoDAO</a></li>
	
	<li><a href="../symbols/VideoDataController.html">VideoDataController</a></li>
	
	<li><a href="../symbols/WebVideoPlayerController.html">WebVideoPlayerController</a></li>
	
</ul>
<hr />
			<!-- end publish.classesIndex -->
		</div>
		
		<div id="content">
<!-- ============================== class title ============================ -->
			<h1 class="classTitle">
				
				Class GridController
			</h1>

<!-- ============================== class summary ========================== -->			
			<p class="description">
				
				
			
				
				
				
					<br /><i>Defined in: </i> <a href="../symbols/src/Workspace_web-to-native-web-app_http-client_js_gridController.js.html">gridController.js</a>.
				
			</p>

<!-- ============================== constructor summary ==================== -->			
			
			<table class="summaryTable" cellspacing="0" summary="A summary of the constructor documented in the class GridController.">
				<caption>Class Summary</caption>
				<thead>
					<tr>
						<th scope="col">Constructor Attributes</th>
						<th scope="col">Constructor Name and Description</th>
					</tr>
				</thead>
				<tbody>
					<tr>
						<td class="attributes">&nbsp;</td>
						<td class="nameDescription" >
							<div class="fixedFont">
								<b><a href="../symbols/GridController.html#constructor">GridController</a></b>(containerId, focusController)
							</div>
							<div class="description">This class creates the grid of items in the UI and handles the relevant
changes as the user selects videos / changes categories</div>
						</td>
					</tr>
				</tbody>
			</table>
			

<!-- ============================== properties summary ===================== -->
			

<!-- ============================== methods summary ======================== -->
			
				
				
				<table class="summaryTable" cellspacing="0" summary="A summary of the methods documented in the class GridController.">
					<caption>Method Summary</caption>
					<thead>
						<tr>
							<th scope="col">Method Attributes</th>
							<th scope="col">Method Name and Description</th>
						</tr>
					</thead>
					<tbody>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont"><b><a href="../symbols/GridController.html#addFocusableItem">addFocusableItem</a></b>(focusableItem)
								</div>
								<div class="description">Add an item to be focused on the FocusController</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont"><b><a href="../symbols/GridController.html#getGridContainerId">getGridContainerId</a></b>()
								</div>
								<div class="description">Get the container Id for the grid</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont"><b><a href="../symbols/GridController.html#getGridItemHTML">getGridItemHTML</a></b>(videoData)
								</div>
								<div class="description">Get the html generated for a grid item</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont"><b><a href="../symbols/GridController.html#getGridItemStyles">getGridItemStyles</a></b>()
								</div>
								<div class="description">Get the styles for the items</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont"><b><a href="../symbols/GridController.html#getItemCallbackFunction">getItemCallbackFunction</a></b>(index, data)
								</div>
								<div class="description">Get an item callback function</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont"><b><a href="../symbols/GridController.html#getItemSelectedCallback">getItemSelectedCallback</a></b>()
								</div>
								<div class="description">Get the item selected callback</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont"><b><a href="../symbols/GridController.html#removeFocusableItems">removeFocusableItems</a></b>()
								</div>
								<div class="description">Removable all the focusable items from the focus controller</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont"><b><a href="../symbols/GridController.html#setFocusController">setFocusController</a></b>(controller)
								</div>
								<div class="description">Set the FocusController for the grid</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont"><b><a href="../symbols/GridController.html#setGridContainerId">setGridContainerId</a></b>(navContainerId)
								</div>
								<div class="description">Set the container Id of the grid</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont"><b><a href="../symbols/GridController.html#setGridData">setGridData</a></b>(gridData)
								</div>
								<div class="description">Set the data needed to populate the grid</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont"><b><a href="../symbols/GridController.html#setGridItemStyles">setGridItemStyles</a></b>(styles)
								</div>
								<div class="description">Set the styles to be applied to the grid during focus state</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont"><b><a href="../symbols/GridController.html#setItemSelectedCallback">setItemSelectedCallback</a></b>(callback)
								</div>
								<div class="description">Set a callback for item selection</div>
							</td>
						</tr>
					
					</tbody>
				</table>
				
				
				
			
<!-- ============================== events summary ======================== -->
			

<!-- ============================== constructor details ==================== -->		
			
			<div class="details"><a name="constructor"> </a>
				<div class="sectionTitle">
					Class Detail
				</div>
				
				<div class="fixedFont">
						<b>GridController</b>(containerId, focusController)
				</div>
				
				<div class="description">
					This class creates the grid of items in the UI and handles the relevant
changes as the user selects videos / changes categories
					
				</div>
				
				
				
				
					
						<dl class="detailList">
						<dt class="heading">Parameters:</dt>
						
							<dt>
								<span class="light fixedFont">{String}</span>  <b>containerId</b>
								
							</dt>
								<dd>The id of the div to place the grid within</dd>
						
							<dt>
								<span class="light fixedFont">{<a href="../symbols/FocusController.html">FocusController</a>}</span>  <b>focusController</b>
								
							</dt>
								<dd>The FocusController for the UI</dd>
						
						</dl>
					
					
					
					
					
					
					

			</div>
			

<!-- ============================== field details ========================== -->		
			

<!-- ============================== method details ========================= -->		
			
				<div class="sectionTitle">
					Method Detail
				</div>
				
					<a name="addFocusableItem"> </a>
					<div class="fixedFont">
					
					
					<b>addFocusableItem</b>(focusableItem)
					
					</div>
					<div class="description">
						Add an item to be focused on the FocusController
						
						
					</div>
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<span class="light fixedFont">{<a href="../symbols/FocusableItem.html">FocusableItem</a>}</span> <b>focusableItem</b>
									
								</dt>
								<dd></dd>
							
							</dl>
						
						
						
						
						
						
						

					<hr />
				
					<a name="getGridContainerId"> </a>
					<div class="fixedFont">
					
					
					<b>getGridContainerId</b>()
					
					</div>
					<div class="description">
						Get the container Id for the grid
						
						
					</div>
					
					
					
						
						
						
						
						
						
						

					<hr />
				
					<a name="getGridItemHTML"> </a>
					<div class="fixedFont">
					
					
					<b>getGridItemHTML</b>(videoData)
					
					</div>
					<div class="description">
						Get the html generated for a grid item
						
						
					</div>
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<span class="light fixedFont">{JSObj}</span> <b>videoData</b>
									
								</dt>
								<dd>The object contains a 'image' & 'title' property</dd>
							
							</dl>
						
						
						
						
						
						
						

					<hr />
				
					<a name="getGridItemStyles"> </a>
					<div class="fixedFont">
					
					
					<b>getGridItemStyles</b>()
					
					</div>
					<div class="description">
						Get the styles for the items
						
						
					</div>
					
					
					
						
						
						
						
						
						
						

					<hr />
				
					<a name="getItemCallbackFunction"> </a>
					<div class="fixedFont">
					
					
					<b>getItemCallbackFunction</b>(index, data)
					
					</div>
					<div class="description">
						Get an item callback function
						
						
					</div>
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<span class="light fixedFont">{int}</span> <b>index</b>
									
								</dt>
								<dd>The index of the selected item</dd>
							
								<dt>
									<span class="light fixedFont">{String}</span> <b>data</b>
									
								</dt>
								<dd>Data relevant to the callback</dd>
							
							</dl>
						
						
						
						
						
						
						

					<hr />
				
					<a name="getItemSelectedCallback"> </a>
					<div class="fixedFont">
					
					
					<b>getItemSelectedCallback</b>()
					
					</div>
					<div class="description">
						Get the item selected callback
						
						
					</div>
					
					
					
						
						
						
						
						
						
						

					<hr />
				
					<a name="removeFocusableItems"> </a>
					<div class="fixedFont">
					
					
					<b>removeFocusableItems</b>()
					
					</div>
					<div class="description">
						Removable all the focusable items from the focus controller
						
						
					</div>
					
					
					
						
						
						
						
						
						
						

					<hr />
				
					<a name="setFocusController"> </a>
					<div class="fixedFont">
					
					
					<b>setFocusController</b>(controller)
					
					</div>
					<div class="description">
						Set the FocusController for the grid
						
						
					</div>
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<span class="light fixedFont">{<a href="../symbols/FocusController.html">FocusController</a>}</span> <b>controller</b>
									
								</dt>
								<dd></dd>
							
							</dl>
						
						
						
						
						
						
						

					<hr />
				
					<a name="setGridContainerId"> </a>
					<div class="fixedFont">
					
					
					<b>setGridContainerId</b>(navContainerId)
					
					</div>
					<div class="description">
						Set the container Id of the grid
						
						
					</div>
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<span class="light fixedFont">{String}</span> <b>navContainerId</b>
									
								</dt>
								<dd>Set the container Id of the div</dd>
							
							</dl>
						
						
						
						
						
						
						

					<hr />
				
					<a name="setGridData"> </a>
					<div class="fixedFont">
					
					
					<b>setGridData</b>(gridData)
					
					</div>
					<div class="description">
						Set the data needed to populate the grid
						
						
					</div>
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<span class="light fixedFont">{Array<JSObj>}</span> <b>gridData</b>
									
								</dt>
								<dd>The objects contain 'image' & 'title'
properties</dd>
							
							</dl>
						
						
						
						
						
						
						

					<hr />
				
					<a name="setGridItemStyles"> </a>
					<div class="fixedFont">
					
					
					<b>setGridItemStyles</b>(styles)
					
					</div>
					<div class="description">
						Set the styles to be applied to the grid during focus state
						
						
					</div>
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<span class="light fixedFont">{JSObject}</span> <b>styles</b>
									
								</dt>
								<dd>Set 'item' and 'focused' properties</dd>
							
							</dl>
						
						
						
						
						
						
						

					<hr />
				
					<a name="setItemSelectedCallback"> </a>
					<div class="fixedFont">
					
					
					<b>setItemSelectedCallback</b>(callback)
					
					</div>
					<div class="description">
						Set a callback for item selection
						
						
					</div>
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<span class="light fixedFont">{function}</span> <b>callback</b>
									
								</dt>
								<dd></dd>
							
							</dl>
						
						
						
						
						
						
						

					
				
			
			
<!-- ============================== event details ========================= -->		
			
			
			<hr />
		</div>

		
<!-- ============================== footer ================================= -->
		<div class="fineprint" style="clear:both">
			
			Documentation generated by <a href="http://code.google.com/p/jsdoc-toolkit/" target="_blank">JsDoc Toolkit</a> 2.4.0 on Tue Aug 28 2012 18:44:06 GMT+0100 (BST)
		</div>
	</body>
</html>
